home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 March / EnigmA AMIGA RUN 05 (1996)(G.R. Edizioni)(IT)[!][issue 1996-03][Skylink CD IV].iso / earcd / ear / mui23dev.lha / MUI / Developer / Autodocs / MUI_String.doc < prev    next >
Text File  |  1994-12-23  |  6KB  |  219 lines
  1. TABLE OF CONTENTS
  2.  
  3. String.mui/String.mui
  4. String.mui/MUIA_String_Accept
  5. String.mui/MUIA_String_Acknowledge
  6. String.mui/MUIA_String_AttachedList
  7. String.mui/MUIA_String_BufferPos
  8. String.mui/MUIA_String_Contents
  9. String.mui/MUIA_String_DisplayPos
  10. String.mui/MUIA_String_EditHook
  11. String.mui/MUIA_String_Format
  12. String.mui/MUIA_String_Integer
  13. String.mui/MUIA_String_MaxLen
  14. String.mui/MUIA_String_Reject
  15. String.mui/MUIA_String_Secret
  16. String.mui/String.mui
  17.  
  18.     String class generates standard string gadgets with
  19.     all editing facilities (clear, undo, etc.) enabled.
  20. String.mui/MUIA_String_Accept
  21.  
  22.     NAME
  23.     MUIA_String_Accept -- (V4 ) [ISG], STRPTR
  24.  
  25.     FUNCTION
  26.     A string containing characters allowed as input
  27.     for the string gadget. Whenever the user hits a
  28.     character not found in MUIA_String_Accept, he
  29.     will hear a beep and gadgets contents won't have 
  30.     changed.
  31.  
  32.     EXAMPLE
  33.     StringObject,
  34.        MUIA_String_Accept, "0123456789-",
  35.        End,
  36.  
  37.     SEE ALSO
  38.     MUIA_String_Reject
  39. String.mui/MUIA_String_Acknowledge
  40.  
  41.     NAME
  42.     MUIA_String_Acknowledge -- (V4 ) [..G], STRPTR
  43.  
  44.     FUNCTION
  45.     This attribute will be set to the contents of the
  46.     string whenever the user hits return in the gadget. 
  47.     An application can listen with notification and take
  48.     the appropriate action.
  49.  
  50.     Using the TAB key or a mouse click to deactivate the
  51.     gadget will not trigger MUIA_String_Acknowledge.
  52.  
  53.     EXAMPLE
  54.     /* two string gadgets str1 and str2, the second should
  55.     /* become active after a return in the first: */
  56.  
  57.     DoMethod(str1,MUIM_Notify,
  58.        MUIA_String_Acknowledge, MUIV_EveryTime,
  59.        windowobj, 3, MUIM_Set, MUIA_Window_ActiveObject, str2);
  60.  
  61.     SEE ALSO
  62.     MUIA_String_Contents
  63. String.mui/MUIA_String_AttachedList
  64.  
  65.     NAME
  66.     MUIA_String_AttachedList -- (V4 ) [I..], Object *
  67.  
  68.     FUNCTION
  69.     This special attribute can be set to point to
  70.     a valid MUI object of List or Listview class.
  71.     This enables controlling the lists cursor
  72.     from within the string gadget, all cursor key
  73.     events will be forwarded.
  74.  
  75.     SEE ALSO
  76.     MUIA_String_Contents, MUIA_List_Active
  77. String.mui/MUIA_String_BufferPos
  78.  
  79.     NAME
  80.     MUIA_String_BufferPos -- (V4 ) [.SG], LONG
  81.  
  82.     FUNCTION
  83.     MUIA_String_BufferPos can be used to get and set the
  84.     position of the cursor in the string gadget.
  85.     This attribute is probably not very interesting.
  86.  
  87.     SEE ALSO
  88.     MUIA_String_Contents, MUIA_String_DisplayPos
  89. String.mui/MUIA_String_Contents
  90.  
  91.     NAME
  92.     MUIA_String_Contents -- (V4 ) [ISG], STRPTR
  93.  
  94.     FUNCTION
  95.     Get and set a string gadgets contents. You may not
  96.     modify the returned string.
  97.  
  98.     MUIA_String_Contents gets updated every time when
  99.     the contents of the string gadget change. When you
  100.     set up a notification on this attribute, you will
  101.     hear about every keystroke.
  102.  
  103.     EXAMPLE
  104.  
  105.     /* The given hook will be called after every change */
  106.     /* in the string gadget. It receives a pointer to   */
  107.     /* a pointer to the current contents in register a1 */
  108.     /* (see MUIM_CallHook for details)                  */
  109.  
  110.     DoMethod(str,MUIM_Notify,
  111.        MUIA_String_Contents, MUIV_EveryTime,
  112.        str, 3, MUIM_CallHook, &hook, MUIV_TriggerValue);
  113.  
  114.     SEE ALSO
  115.     MUIA_String_Accept, MUIA_String_Reject, MUIA_String_MaxLen
  116. String.mui/MUIA_String_DisplayPos
  117.  
  118.     NAME
  119.     MUIA_String_DisplayPos -- (V4 ) [.SG], LONG
  120.  
  121.     FUNCTION
  122.     MUIA_String_DisplayPos can be used to get and set the
  123.     number of the first character of the string to be
  124.     displayed. This attribute is probably not very
  125.     interesting.
  126.  
  127.     SEE ALSO
  128.     MUIA_String_Contents, MUIA_String_BufferPos
  129. String.mui/MUIA_String_EditHook
  130.  
  131.     NAME
  132.     MUIA_String_EditHook -- (V7 ) [ISG], struct Hook *
  133.  
  134.     FUNCTION
  135.     When specified, MUI calls this hook as if it was a real
  136.     string edit hook in a real string gadget. It receives
  137.     a pointer to itself in A0, a pointer to a SGWork structure
  138.     in A2 and a pointer to the message in A1.
  139.  
  140.     The hook will be called before MUI's private edit hook,
  141.     the result is unused.
  142. String.mui/MUIA_String_Format
  143.  
  144.     NAME
  145.     MUIA_String_Format -- (V4 ) [I.G], LONG
  146.  
  147.     SPECIAL INPUTS
  148.     MUIV_String_Format_Left
  149.     MUIV_String_Format_Center
  150.     MUIV_String_Format_Right
  151.  
  152.     FUNCTION
  153.     Used to adjust the alignment of the input string.
  154.  
  155.     SEE ALSO
  156.     MUIA_String_BufferPos, MUIA_String_DispPos, MUIA_String_Contents
  157. String.mui/MUIA_String_Integer
  158.  
  159.     NAME
  160.     MUIA_String_Integer -- (V4 ) [ISG], ULONG
  161.  
  162.     FUNCTION
  163.     Useful for turning a string gadget into an integer
  164.     gadget. Setting this attribute puts the value
  165.     with "%ld" into the gadget, getting it returns
  166.     a longword containing the string gadgets contents
  167.     as number.
  168.  
  169.     You should set MUIA_String_Accept to "0123456789"
  170.     or something like that to avoid wrong characters.
  171.  
  172.     EXAMPLE
  173.     StringObject,
  174.        MUIA_String_Accept , "0123456879",
  175.        MUIA_String_Integer, 42,
  176.        End;
  177. String.mui/MUIA_String_MaxLen
  178.  
  179.     NAME
  180.     MUIA_String_MaxLen -- (V4 ) [I.G], LONG
  181.  
  182.     FUNCTION
  183.     Setup the maximum length for the string gadget.
  184.     This attribute is only valid at object creation time.
  185.  
  186.     Default maximum length is 80.
  187.  
  188.     NOTE: The maximum length includes the 0-byte at the end
  189.           of the string. To let the user enter e.g. 10 characters,
  190.           you would have to specify a maxlen of 11.
  191.  
  192.     SEE ALSO
  193.     MUIA_String_Contents
  194. String.mui/MUIA_String_Reject
  195.  
  196.     NAME
  197.     MUIA_String_Reject -- (V4 ) [ISG], STRPTR
  198.  
  199.     FUNCTION
  200.     A string containing characters that should not be
  201.     accepted as input for the string gadget. Whenever
  202.     the user hits such a char, he will hear a beep
  203.     and gadgets contents won't have changed.
  204.  
  205.     SEE ALSO
  206.     MUIA_String_Accept
  207. String.mui/MUIA_String_Secret
  208.  
  209.     NAME
  210.     MUIA_String_Secret -- (V4 ) [I.G], BOOL
  211.  
  212.     FUNCTION
  213.     This attribute causes the string gadget to display only
  214.     dots instead of the real contents. Useful for password
  215.     requesters.
  216.  
  217.     SEE ALSO
  218.     MUIA_String_Contents
  219.